Skip to main content

Sync client data

GET /api/v1/Clients/sync

Description​

This endpoint is used to synchronize client data.

Tags: Clients

URL:
/api/v{version}/Clients/sync

ApiKey:
No API key required

Content-Type:
No request body

Query Parameters:
ClientId: integer, optional (nullable)
version: string, required

Accept-Language: header, optional, change the default response message language from English (en) to French (fr) or English (en)

Response:
Success, returns the list of clients.

Error Codes:
400: Bad Request
404: Resource not found
500: Internal server error

Example:

bash
GET /api/v1/Clients/sync?ClientId=123&Accept-Language=fr

/api/v`{{version}}`/Clients/sync?ClientId=<integer>

Headers​

Content-TypeValue
Accept-Language

Query Params​

Paramvalue
ClientId<integer>

Response: 200​

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1/Clients/sync \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!